Simular conclusao de pagamento de boleto

Disponivel somente em homologacao

Esta rota de simulacao funciona somente no ambiente de homologacao. Nao utilize esta rota em fluxos de producao.

Use esta rota para simular a conclusao de uma cobranca de boleto no ambiente de homologacao.

Voce pode simular a conclusao por dados do boleto ou por Pix. Ao usar PIX, informe o correlationId do boleto no parametro de rota {id}.

Requisicao

URL

POST 'https://apisandbox.delbank.com.br/baas/v1/charges/{id}/simulate-conclude'

cURL

curl --request POST \
     --url 'https://apisandbox.delbank.com.br/baas/v1/charges/{id}/simulate-conclude' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-delbank-api-key: {{apiKey}}' \
     --header 'x-delfinance-account-id: {{accountId}}' \
     --data '{"type":"BANKSLIP"}'

Headers

Nome	Descricao
x-delbank-api-key	Obrigatorio. Chave de API
x-delfinance-account-id	Obrigatorio. O numero da conta Delfinance

Parametros path

Nome	Tipo	Descricao
id	string	Obrigatorio. Identificador da cobranca de boleto que sera simulada. Para BANKSLIP, informe a linha digitavel ou o codigo de barras. Para PIX, informe o correlationId do boleto.

Corpo da requisicao

Nome	Tipo	Descricao
type	string	Obrigatorio. Tipo da simulacao. Use BANKSLIP ou PIX.

Exemplo de corpo

Boleto

{
  "type": "BANKSLIP"
}

Pix

{
  "type": "PIX"
}

Resposta

A resposta esperada e 202 Accepted.

{
  "correlationId": "string",
  "referenceId": "string",
  "amount": 150.5,
  "source": "PCR",
  "date": "2026-05-21T13:30:15Z",
  "paymentDate": "2026-05-21T13:30:15Z",
  "issuer": {
    "ispb": "string",
    "code": "string",
    "branch": "string",
    "agency": "string",
    "name": "string",
    "type": "PJ",
    "document": "string",
    "fantasyName": "string"
  },
  "additionalData": {
    "simulator": "DelbankSimulator",
    "message": "Pagamento de boleto simulado em ambiente de homologacao",
    "bankAccount": "string",
    "correlationId": "string",
    "ourNumber": "string",
    "barCode": "string",
    "digitableLine": "string"
  }
}

Erros possiveis

Tipo de pagamento nao informado

Status: 400 Bad Request

{
  "title": "Please refer to the errors property for additional details.",
  "errors": [
    "Tipo de pagamento nao pode ser nulo"
  ]
}

Tipo invalido

Status: 400 Bad Request

{
  "title": "Please refer to the errors property for additional details.",
  "errors": [
    "Tipo de pagamento invalido"
  ]
}

Identificador nao informado

Status: 400 Bad Request

{
  "title": "Please refer to the errors property for additional details.",
  "errors": [
    "Identificador da cobranca deve ser informado"
  ]
}